home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / tcl / tcl67.lha / tcl6.7 / doc / Backslash.3 < prev    next >
Text File  |  1993-01-31  |  2KB  |  58 lines
  1. '\"
  2. '\" Copyright 1989 Regents of the University of California
  3. '\" Permission to use, copy, modify, and distribute this
  4. '\" documentation for any purpose and without fee is hereby
  5. '\" granted, provided that this notice appears in all copies.
  6. '\" The University of California makes no representations about
  7. '\" the suitability of this material for any purpose.  It is
  8. '\" provided "as is" without express or implied warranty.
  9. '\" 
  10. '\" $Header: /user6/ouster/tcl/man/RCS/Backslash.3,v 1.9 93/01/31 15:35:28 ouster Exp $ SPRITE (Berkeley)
  11. '\" 
  12. .so man.macros
  13. .HS Tcl_Backslash tcl
  14. .BS
  15. .SH NAME
  16. Tcl_Backslash \- parse a backslash sequence
  17. .SH SYNOPSIS
  18. .nf
  19. \fB#include <tcl.h>\fR
  20. .sp
  21. char
  22. \fBTcl_Backslash\fR(\fIsrc, countPtr\fR)
  23. .SH ARGUMENTS
  24. .AS char *countPtr
  25. .AP char *src in
  26. Pointer to a string starting with a backslash.
  27. .AP int *countPtr out
  28. If \fIcountPtr\fR isn't NULL, \fI*countPtr\fR gets filled
  29. in with number of characters in the backslash sequence, including
  30. the backslash character.
  31. .BE
  32.  
  33. .SH DESCRIPTION
  34. .PP
  35. This is a utility procedure used by several of the Tcl
  36. commands.  It parses a backslash sequence and returns
  37. the single character corresponding to the sequence.
  38. .VS
  39. If the backslash sequence should be replaced by no character
  40. at all (e.g. backslash-newline) then \fBTcl_Backslash\fR returns 0.
  41. .VE
  42. \fBTcl_Backslash\fR modifies \fI*countPtr\fR to contain the number
  43. of characters in the backslash sequence.
  44. If \fIsrc\fR doesn't point to a backslash
  45. sequence understood by Tcl, then Tcl_Backslash returns a backslash
  46. as its result and \fI*countPtr\fR gets set to 1 (in this case the
  47. backslash character should not get any special treatment).
  48. .PP
  49. See the Tcl manual entry for information on the valid
  50. backslash sequences.
  51. .VS
  52. All of the sequences described in the Tcl
  53. manual entry are supported by \fBTcl_Backslash\fR.
  54. .VE
  55.  
  56. .SH KEYWORDS
  57. backslash, parse
  58.